<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: session/error.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_938858dd290fe54e59e3500689c41d32.html">session</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">error.cpp</div></div>
</div><!--header-->
<div class="contents">
<a href="ipc__session_2src_2ipc_2session_2error_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Sessions</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#include &quot;<a class="code" href="ipc__session_2src_2ipc_2session_2error_8hpp.html">ipc/session/error.hpp</a>&quot;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#include &quot;<a class="code" href="util__fwd_8hpp.html">ipc/util/util_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="namespaceipc_1_1session_1_1error.html">   22</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1session_1_1error.html">ipc::session::error</a></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span>{</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment"></span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment">/**</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment"> * The boost.system category for errors returned by the ipc::session module.  Analogous to</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment"> * transport::error::Category.  All notes therein apply.</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"> */</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1error_1_1Category.html">   31</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1session_1_1error_1_1Category.html">Category</a> :</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>  <span class="keyword">public</span> <a class="code hl_class" href="classboost_1_1system_1_1error__category.html">boost::system::error_category</a></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>{</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>  <span class="comment">// Constants.</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"></span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment">  /// The one Category.</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1error_1_1Category.html#a417c7ef876c95c869f1c62d74820d3c4">   38</a></span><span class="comment"></span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1session_1_1error_1_1Category.html">Category</a> <a class="code hl_variable" href="classipc_1_1session_1_1error_1_1Category.html#a417c7ef876c95c869f1c62d74820d3c4">S_CATEGORY</a>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"></span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment">   * Analogous to transport::error::Category::name().</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment">   *</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment">   */</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_function" href="classipc_1_1session_1_1error_1_1Category.html#abc076c91c6b61108d6c25eb59740e774">name</a>() const noexcept override;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"></span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment">   * Analogous to transport::error::Category::name().</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment">   *</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment">   * @param val</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment">   */</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span>  std::<span class="keywordtype">string</span> <a class="code hl_function" href="classipc_1_1session_1_1error_1_1Category.html#a132d8e9d6675441c5eefd9895faea8bb">message</a>(<span class="keywordtype">int</span> val) const override;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"></span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment">   * Analogous to transport::error::Category::name().</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment">   * @param code</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment">   */</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>  static util::<a class="code hl_typedef" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">String_view</a> <a class="code hl_function" href="classipc_1_1session_1_1error_1_1Category.html#a29c3783e5cc2b9e5df5401fca45949e5">code_symbol</a>(<a class="code hl_enumeration" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2f">Code</a> code);</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span>private:</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span>  <span class="comment">// Constructors.</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"></span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment">  /// Boring constructor.</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1error_1_1Category.html#adc1f303130824a568624c449ff2bba87">   70</a></span><span class="comment"></span>  explicit <a class="code hl_class" href="classipc_1_1session_1_1error_1_1Category.html">Category</a>();</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span>}; <span class="comment">// class Category</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment">// Static initializations.</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span>const <a class="code hl_class" href="classipc_1_1session_1_1error_1_1Category.html">Category</a> <a class="code hl_class" href="classipc_1_1session_1_1error_1_1Category.html">Category</a>::<a class="code hl_variable" href="classipc_1_1session_1_1error_1_1Category.html#a417c7ef876c95c869f1c62d74820d3c4">S_CATEGORY</a>;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment">// Implementations.</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="namespaceipc_1_1session_1_1error.html#a9056f277d3ebf2778d06a2bb1f337c28">   79</a></span><a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> <a class="code hl_function" href="namespaceipc_1_1session_1_1error.html#a9056f277d3ebf2778d06a2bb1f337c28">make_error_code</a>(<a class="code hl_enumeration" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2f">Code</a> err_code)</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span>{</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span>  <span class="comment">/* Assign Category as the category for flow::error::Code-cast error_codes;</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment">   * this basically glues together Category::name()/message() with the Code enum. */</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span>  <span class="keywordflow">return</span> <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>(<span class="keyword">static_cast&lt;</span><span class="keywordtype">int</span><span class="keyword">&gt;</span>(err_code), <a class="code hl_variable" href="classipc_1_1session_1_1error_1_1Category.html#a417c7ef876c95c869f1c62d74820d3c4">Category::S_CATEGORY</a>);</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span>}</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><a class="code hl_function" href="classipc_1_1session_1_1error_1_1Category.html#adc1f303130824a568624c449ff2bba87">Category::Category</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1error_1_1Category.html#abc076c91c6b61108d6c25eb59740e774">   88</a></span><span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_function" href="classipc_1_1session_1_1error_1_1Category.html#abc076c91c6b61108d6c25eb59740e774">Category::name</a>() const noexcept <span class="comment">// Virtual.</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span>{</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span>  <span class="keywordflow">return</span> <span class="stringliteral">&quot;ipc/session&quot;</span>;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span>}</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1error_1_1Category.html#a132d8e9d6675441c5eefd9895faea8bb">   93</a></span>std::string <a class="code hl_function" href="classipc_1_1session_1_1error_1_1Category.html#a132d8e9d6675441c5eefd9895faea8bb">Category::message</a>(<span class="keywordtype">int</span> val) <span class="keyword">const</span> <span class="comment">// Virtual.</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span>{</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>  <span class="keyword">using </span>std::string;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span>  <span class="comment">// KEEP THESE STRINGS IN SYNC WITH COMMENT IN error.hpp ON THE INDIVIDUAL ENUM MEMBERS!</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span> </div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span>  <span class="comment">// See notes in transport::error in same spot.</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span>  <span class="keywordflow">switch</span> (<span class="keyword">static_cast&lt;</span><a class="code hl_enumeration" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2f">Code</a><span class="keyword">&gt;</span>(val))</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span>  {</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fac416e988563e44bf15fc6a81743eef53">Code::S_INVALID_ARGUMENT</a>:</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;User called an API with 1 or more arguments against the API spec.&quot;</span>;</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fafe29343445a7bf167cc186a44bd2c6ed">Code::S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER</a>:</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;Async completion handler is being called prematurely, because underlying object is shutting down, &quot;</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span>           <span class="stringliteral">&quot;as user desires.&quot;</span>;</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa486f5607320d062fe89e559a1e7856b2">Code::S_CLIENT_NAMESPACE_STORE_BAD_FORMAT</a>:</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;Session master channel: log-in as client: The Client Namespace Store (CNS) file (a/k/a PID file) lacks &quot;</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span>           <span class="stringliteral">&quot;leading newline-terminated line with numeric PID.&quot;</span>;</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa866090a4d042120126722b4daf1ecc33">Code::S_CLIENT_MASTER_LOG_IN_RESPONSE_BAD</a>:</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;Session master channel: log-in as client: received log-in response is not the expected internal message.&quot;</span>;</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2faa195e468548ba9602c27590f2d6d49f0">Code::S_SERVER_MASTER_LOG_IN_REQUEST_CLIENT_APP_DISALLOWED_OR_UNKNOWN</a>:</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;Session master channel: log-in as server: client identifies self as unknown client-app or one that is not &quot;</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span>           <span class="stringliteral">&quot;registered as an allowed partner to this server-app.&quot;</span>;</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa3f305ed5a242f067c9116216c0674264">Code::S_SERVER_MASTER_LOG_IN_REQUEST_CLIENT_APP_INCONSISTENT_CREDS</a>:</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;Session master channel: log-in as server: client application-level process credentials (UID, etc.) &quot;</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span>           <span class="stringliteral">&quot;do not match the registered values and/or the OS-reported client peer values from socket stream.&quot;</span>;</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa2c8c27c65ff6234220a84f96de8a1870">Code::S_SESSION_OPEN_CHANNEL_REMOTE_PEER_REJECTED_PASSIVE_OPEN</a>:</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;Session channel opening: User code chose to reject all passive-open requests.&quot;</span>;</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa10d32cf1382fb003f09a6df2da408574">Code::S_SESSION_OPEN_CHANNEL_SERVER_CANNOT_PROCEED_RESOURCE_UNAVAILABLE</a>:</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;Session channel opening: Server peer is responsible for low-level resource acquisition but failed &quot;</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span>             <span class="stringliteral">&quot;to do so.  Session continues; this is not a fatal error.&quot;</span>;</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa7d85b87223a9b277b8875c1f7971d6ad">Code::S_SESSION_OPEN_CHANNEL_ACTIVE_TIMEOUT</a>:</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;Session channel opening: &quot;</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span>             <span class="stringliteral">&quot;Other peer must reply quickly enough as-if non-blocking but did not do so in time.&quot;</span>;</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa7300721595cc25baa9a9e43bd76296aa">Code::S_MUTEX_BIPC_MISC_LIBRARY_ERROR</a>:</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;Low-level boost.ipc.mutex: boost.interprocess emitted miscellaneous library exception sans a system code; &quot;</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span>           <span class="stringliteral">&quot;a WARNING message at throw-time should contain all possible details.&quot;</span>;</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa8fe83fc1ea258698473af610c0023a9d">Code::S_SERVER_MASTER_POST_LOG_IN_SEND_FAILED_MISC</a>:</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;Session master channel: post-log-in setup (such as SHM setup): send failed because channel hosed &quot;</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span>           <span class="stringliteral">&quot;around that time.  Timing was such that exact reason for this could not be obtained, but &quot;</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>           <span class="stringliteral">&quot;logs will show it.&quot;</span>;</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fac734bd48bbfe30867f627363a8d5afc4">Code::S_SERVER_MASTER_LOG_IN_REQUEST_CONFIG_MISMATCH</a>:</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;Session master channel: log-in as server: opposing client&#39;s compile-time type config differs from &quot;</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span>           <span class="stringliteral">&quot;local server&#39;s counterpart config; did you use the proper Server/Client_session paired templates and &quot;</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span>           <span class="stringliteral">&quot;mutually equal template parameters?&quot;</span>;</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa5c437fa266aea0c8e2b348ee84dd61fa">Code::S_RESOURCE_OWNER_UNEXPECTED</a>:</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;A resource in the file system (file, SHM pool, MQ, etc.) has or could have unexpected owner; &quot;</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span>           <span class="stringliteral">&quot;ipc::session may emit this when acquiring resources and/or opening session if the server process &quot;</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span>           <span class="stringliteral">&quot;is not running as the configured user, or a previous iteration was not running as that user.&quot;</span>;</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa24eaed39f149e32f6ceaad54d24f8759">Code::S_SESSION_FINISHED</a>:</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;The opposing end of the session in question has been closed gracefully by the user invoking the &quot;</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span>           <span class="stringliteral">&quot;end-session API.&quot;</span>;</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span> </div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa6fba12db09e5bebfaa04f6372c41c2cf">Code::S_END_SENTINEL</a>:</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span>    assert(<span class="keyword">false</span> &amp;&amp; <span class="stringliteral">&quot;SENTINEL: Not an error.  &quot;</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span>                    <span class="stringliteral">&quot;This Code must never be issued by an error/success-emitting API; I/O use only.&quot;</span>);</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span>  }</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span>  assert(<span class="keyword">false</span>);</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span>  <span class="keywordflow">return</span> <span class="stringliteral">&quot;&quot;</span>;</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span>} <span class="comment">// Category::message()</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span> </div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1error_1_1Category.html#a29c3783e5cc2b9e5df5401fca45949e5">  153</a></span><a class="code hl_typedef" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">util::String_view</a> <a class="code hl_function" href="classipc_1_1session_1_1error_1_1Category.html#a29c3783e5cc2b9e5df5401fca45949e5">Category::code_symbol</a>(<a class="code hl_enumeration" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2f">Code</a> code) <span class="comment">// Static.</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span>{</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span>  <span class="comment">// Note: Must satisfy istream_to_enum() requirements.</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span> </div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span>  <span class="keywordflow">switch</span> (code)</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span>  {</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fac416e988563e44bf15fc6a81743eef53">Code::S_INVALID_ARGUMENT</a>:</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;INVALID_ARGUMENT&quot;</span>;</div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fafe29343445a7bf167cc186a44bd2c6ed">Code::S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER</a>:</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER&quot;</span>;</div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa486f5607320d062fe89e559a1e7856b2">Code::S_CLIENT_NAMESPACE_STORE_BAD_FORMAT</a>:</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;CLIENT_NAMESPACE_STORE_BAD_FORMAT&quot;</span>;</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa866090a4d042120126722b4daf1ecc33">Code::S_CLIENT_MASTER_LOG_IN_RESPONSE_BAD</a>:</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;CLIENT_MASTER_LOG_IN_RESPONSE_BAD&quot;</span>;</div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2faa195e468548ba9602c27590f2d6d49f0">Code::S_SERVER_MASTER_LOG_IN_REQUEST_CLIENT_APP_DISALLOWED_OR_UNKNOWN</a>:</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;SERVER_MASTER_LOG_IN_REQUEST_CLIENT_APP_DISALLOWED_OR_UNKNOWN&quot;</span>;</div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa3f305ed5a242f067c9116216c0674264">Code::S_SERVER_MASTER_LOG_IN_REQUEST_CLIENT_APP_INCONSISTENT_CREDS</a>:</div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;SERVER_MASTER_LOG_IN_REQUEST_CLIENT_APP_INCONSISTENT_CREDS&quot;</span>;</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa2c8c27c65ff6234220a84f96de8a1870">Code::S_SESSION_OPEN_CHANNEL_REMOTE_PEER_REJECTED_PASSIVE_OPEN</a>:</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;SESSION_OPEN_CHANNEL_REMOTE_PEER_REJECTED_PASSIVE_OPEN&quot;</span>;</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa10d32cf1382fb003f09a6df2da408574">Code::S_SESSION_OPEN_CHANNEL_SERVER_CANNOT_PROCEED_RESOURCE_UNAVAILABLE</a>:</div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;SESSION_OPEN_CHANNEL_SERVER_CANNOT_PROCEED_RESOURCE_UNAVAILABLE&quot;</span>;</div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa7d85b87223a9b277b8875c1f7971d6ad">Code::S_SESSION_OPEN_CHANNEL_ACTIVE_TIMEOUT</a>:</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;SESSION_OPEN_CHANNEL_ACTIVE_TIMEOUT&quot;</span>;</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa7300721595cc25baa9a9e43bd76296aa">Code::S_MUTEX_BIPC_MISC_LIBRARY_ERROR</a>:</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;MUTEX_BIPC_MISC_LIBRARY_ERROR&quot;</span>;</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa8fe83fc1ea258698473af610c0023a9d">Code::S_SERVER_MASTER_POST_LOG_IN_SEND_FAILED_MISC</a>:</div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;SERVER_MASTER_POST_LOG_IN_SEND_FAILED_MISC&quot;</span>;</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fac734bd48bbfe30867f627363a8d5afc4">Code::S_SERVER_MASTER_LOG_IN_REQUEST_CONFIG_MISMATCH</a>:</div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;SERVER_MASTER_LOG_IN_REQUEST_CONFIG_MISMATCH&quot;</span>;</div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa5c437fa266aea0c8e2b348ee84dd61fa">Code::S_RESOURCE_OWNER_UNEXPECTED</a>:</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;RESOURCE_OWNER_UNEXPECTED&quot;</span>;</div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa24eaed39f149e32f6ceaad54d24f8759">Code::S_SESSION_FINISHED</a>:</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;SESSION_FINISHED&quot;</span>;</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span> </div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span>  <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa6fba12db09e5bebfaa04f6372c41c2cf">Code::S_END_SENTINEL</a>:</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span>    <span class="keywordflow">return</span> <span class="stringliteral">&quot;END_SENTINEL&quot;</span>;</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span>  }</div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span>  assert(<span class="keyword">false</span>);</div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span>  <span class="keywordflow">return</span> <span class="stringliteral">&quot;&quot;</span>;</div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span>}</div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span> </div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"><a class="line" href="namespaceipc_1_1session_1_1error.html#ad52f227f6cd73969ba6a898028264413">  195</a></span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1session_1_1error.html#ad52f227f6cd73969ba6a898028264413">operator&lt;&lt;</a>(std::ostream&amp; os, <a class="code hl_enumeration" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2f">Code</a> val)</div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span>{</div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span>  <span class="comment">// Note: Must satisfy istream_to_enum() requirements.</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span>  <span class="keywordflow">return</span> os &lt;&lt; <a class="code hl_function" href="classipc_1_1session_1_1error_1_1Category.html#a29c3783e5cc2b9e5df5401fca45949e5">Category::code_symbol</a>(val);</div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span>}</div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span> </div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno"><a class="line" href="namespaceipc_1_1session_1_1error.html#a6041e74db4e17a75d8eed2541dc026f6">  201</a></span>std::istream&amp; <a class="code hl_function" href="namespaceipc_1_1session_1_1error.html#a6041e74db4e17a75d8eed2541dc026f6">operator&gt;&gt;</a>(std::istream&amp; is, <a class="code hl_enumeration" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2f">Code</a>&amp; val)</div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span>{</div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span>  <span class="comment">/* Range [&lt;1st Code&gt;, END_SENTINEL); no match =&gt; END_SENTINEL;</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment">   * allow for number instead of ostream&lt;&lt; string; case-insensitive. */</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span>  val = flow::util::istream_to_enum(&amp;is, <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa6fba12db09e5bebfaa04f6372c41c2cf">Code::S_END_SENTINEL</a>, <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa6fba12db09e5bebfaa04f6372c41c2cf">Code::S_END_SENTINEL</a>, <span class="keyword">true</span>, <span class="keyword">false</span>,</div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span>                                    <a class="code hl_enumeration" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2f">Code</a>(<a class="code hl_variable" href="namespaceipc_1_1session_1_1error.html#aded1c40e8ae8a6ba0b9af47ab48a13bb">S_CODE_LOWEST_INT_VALUE</a>));</div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span>  <span class="keywordflow">return</span> is;</div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span>}</div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span> </div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span>} <span class="comment">// namespace ipc::session::error</span></div>
<div class="ttc" id="aclassboost_1_1system_1_1error__category_html"><div class="ttname"><a href="classboost_1_1system_1_1error__category.html">boost::system::error_category</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1error_1_1Category_html"><div class="ttname"><a href="classipc_1_1session_1_1error_1_1Category.html">ipc::session::error::Category</a></div><div class="ttdoc">The boost.system category for errors returned by the ipc::session module.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2error_8cpp_source.html#l00031">error.cpp:33</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1error_1_1Category_html_a132d8e9d6675441c5eefd9895faea8bb"><div class="ttname"><a href="classipc_1_1session_1_1error_1_1Category.html#a132d8e9d6675441c5eefd9895faea8bb">ipc::session::error::Category::message</a></div><div class="ttdeci">std::string message(int val) const override</div><div class="ttdoc">Analogous to transport::error::Category::name().</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2error_8cpp_source.html#l00093">error.cpp:93</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1error_1_1Category_html_a29c3783e5cc2b9e5df5401fca45949e5"><div class="ttname"><a href="classipc_1_1session_1_1error_1_1Category.html#a29c3783e5cc2b9e5df5401fca45949e5">ipc::session::error::Category::code_symbol</a></div><div class="ttdeci">static util::String_view code_symbol(Code code)</div><div class="ttdoc">Analogous to transport::error::Category::name().</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2error_8cpp_source.html#l00153">error.cpp:153</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1error_1_1Category_html_a417c7ef876c95c869f1c62d74820d3c4"><div class="ttname"><a href="classipc_1_1session_1_1error_1_1Category.html#a417c7ef876c95c869f1c62d74820d3c4">ipc::session::error::Category::S_CATEGORY</a></div><div class="ttdeci">static const Category S_CATEGORY</div><div class="ttdoc">The one Category.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2error_8cpp_source.html#l00038">error.cpp:38</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1error_1_1Category_html_abc076c91c6b61108d6c25eb59740e774"><div class="ttname"><a href="classipc_1_1session_1_1error_1_1Category.html#abc076c91c6b61108d6c25eb59740e774">ipc::session::error::Category::name</a></div><div class="ttdeci">const char * name() const noexcept override</div><div class="ttdoc">Analogous to transport::error::Category::name().</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2error_8cpp_source.html#l00088">error.cpp:88</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1error_1_1Category_html_adc1f303130824a568624c449ff2bba87"><div class="ttname"><a href="classipc_1_1session_1_1error_1_1Category.html#adc1f303130824a568624c449ff2bba87">ipc::session::error::Category::Category</a></div><div class="ttdeci">Category()</div><div class="ttdoc">Boring constructor.</div></div>
<div class="ttc" id="aipc__session_2src_2ipc_2session_2error_8hpp_html"><div class="ttname"><a href="ipc__session_2src_2ipc_2session_2error_8hpp.html">error.hpp</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html">ipc::session::error</a></div><div class="ttdoc">Namespace containing the ipc::session module's extension of boost.system error conventions,...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2error_8cpp_source.html#l00022">error.cpp:23</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a0708d4bec9ae853f4d7e3d7822fc8f2f"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2f">ipc::session::error::Code</a></div><div class="ttdeci">Code</div><div class="ttdoc">All possible errors returned (via Error_code arguments) by ipc::session functions/methods outside of ...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2error_8hpp_source.html#l00046">error.hpp:47</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a0708d4bec9ae853f4d7e3d7822fc8f2fa10d32cf1382fb003f09a6df2da408574"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa10d32cf1382fb003f09a6df2da408574">ipc::session::error::Code::S_SESSION_OPEN_CHANNEL_SERVER_CANNOT_PROCEED_RESOURCE_UNAVAILABLE</a></div><div class="ttdeci">@ S_SESSION_OPEN_CHANNEL_SERVER_CANNOT_PROCEED_RESOURCE_UNAVAILABLE</div><div class="ttdoc">Session channel opening: Server peer is responsible for low-level resource acquisition but failed to ...</div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a0708d4bec9ae853f4d7e3d7822fc8f2fa24eaed39f149e32f6ceaad54d24f8759"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa24eaed39f149e32f6ceaad54d24f8759">ipc::session::error::Code::S_SESSION_FINISHED</a></div><div class="ttdeci">@ S_SESSION_FINISHED</div><div class="ttdoc">The opposing end of the session in question has been closed gracefully by the user invoking the end-s...</div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a0708d4bec9ae853f4d7e3d7822fc8f2fa2c8c27c65ff6234220a84f96de8a1870"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa2c8c27c65ff6234220a84f96de8a1870">ipc::session::error::Code::S_SESSION_OPEN_CHANNEL_REMOTE_PEER_REJECTED_PASSIVE_OPEN</a></div><div class="ttdeci">@ S_SESSION_OPEN_CHANNEL_REMOTE_PEER_REJECTED_PASSIVE_OPEN</div><div class="ttdoc">Session channel opening: User code chose to reject all passive-open requests.</div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a0708d4bec9ae853f4d7e3d7822fc8f2fa3f305ed5a242f067c9116216c0674264"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa3f305ed5a242f067c9116216c0674264">ipc::session::error::Code::S_SERVER_MASTER_LOG_IN_REQUEST_CLIENT_APP_INCONSISTENT_CREDS</a></div><div class="ttdeci">@ S_SERVER_MASTER_LOG_IN_REQUEST_CLIENT_APP_INCONSISTENT_CREDS</div><div class="ttdoc">Session master channel: log-in as server: client application-level process credentials (UID,...</div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a0708d4bec9ae853f4d7e3d7822fc8f2fa486f5607320d062fe89e559a1e7856b2"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa486f5607320d062fe89e559a1e7856b2">ipc::session::error::Code::S_CLIENT_NAMESPACE_STORE_BAD_FORMAT</a></div><div class="ttdeci">@ S_CLIENT_NAMESPACE_STORE_BAD_FORMAT</div><div class="ttdoc">Session master channel: log-in as client: The Client Namespace Store (CNS) file (a/k/a PID file) lack...</div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a0708d4bec9ae853f4d7e3d7822fc8f2fa5c437fa266aea0c8e2b348ee84dd61fa"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa5c437fa266aea0c8e2b348ee84dd61fa">ipc::session::error::Code::S_RESOURCE_OWNER_UNEXPECTED</a></div><div class="ttdeci">@ S_RESOURCE_OWNER_UNEXPECTED</div><div class="ttdoc">A resource in the file system (file, SHM pool, MQ, etc.) has or could have unexpected owner; ipc::ses...</div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a0708d4bec9ae853f4d7e3d7822fc8f2fa6fba12db09e5bebfaa04f6372c41c2cf"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa6fba12db09e5bebfaa04f6372c41c2cf">ipc::session::error::Code::S_END_SENTINEL</a></div><div class="ttdeci">@ S_END_SENTINEL</div><div class="ttdoc">SENTINEL: Not an error. This Code must never be issued by an error/success-emitting API; I/O use only...</div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a0708d4bec9ae853f4d7e3d7822fc8f2fa7300721595cc25baa9a9e43bd76296aa"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa7300721595cc25baa9a9e43bd76296aa">ipc::session::error::Code::S_MUTEX_BIPC_MISC_LIBRARY_ERROR</a></div><div class="ttdeci">@ S_MUTEX_BIPC_MISC_LIBRARY_ERROR</div><div class="ttdoc">Low-level boost.ipc.mutex: boost.interprocess emitted miscellaneous library exception sans a system c...</div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a0708d4bec9ae853f4d7e3d7822fc8f2fa7d85b87223a9b277b8875c1f7971d6ad"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa7d85b87223a9b277b8875c1f7971d6ad">ipc::session::error::Code::S_SESSION_OPEN_CHANNEL_ACTIVE_TIMEOUT</a></div><div class="ttdeci">@ S_SESSION_OPEN_CHANNEL_ACTIVE_TIMEOUT</div><div class="ttdoc">Session channel opening: Other peer must reply quickly enough as-if non-blocking but did not do so in...</div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a0708d4bec9ae853f4d7e3d7822fc8f2fa866090a4d042120126722b4daf1ecc33"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa866090a4d042120126722b4daf1ecc33">ipc::session::error::Code::S_CLIENT_MASTER_LOG_IN_RESPONSE_BAD</a></div><div class="ttdeci">@ S_CLIENT_MASTER_LOG_IN_RESPONSE_BAD</div><div class="ttdoc">Session master channel: log-in as client: received log-in response is not the expected internal messa...</div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a0708d4bec9ae853f4d7e3d7822fc8f2fa8fe83fc1ea258698473af610c0023a9d"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa8fe83fc1ea258698473af610c0023a9d">ipc::session::error::Code::S_SERVER_MASTER_POST_LOG_IN_SEND_FAILED_MISC</a></div><div class="ttdeci">@ S_SERVER_MASTER_POST_LOG_IN_SEND_FAILED_MISC</div><div class="ttdoc">Session master channel: post-log-in setup (such as SHM setup): send failed because channel hosed arou...</div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a0708d4bec9ae853f4d7e3d7822fc8f2faa195e468548ba9602c27590f2d6d49f0"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2faa195e468548ba9602c27590f2d6d49f0">ipc::session::error::Code::S_SERVER_MASTER_LOG_IN_REQUEST_CLIENT_APP_DISALLOWED_OR_UNKNOWN</a></div><div class="ttdeci">@ S_SERVER_MASTER_LOG_IN_REQUEST_CLIENT_APP_DISALLOWED_OR_UNKNOWN</div><div class="ttdoc">Session master channel: log-in as server: client identifies self as unknown client-app or one that is...</div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a0708d4bec9ae853f4d7e3d7822fc8f2fac416e988563e44bf15fc6a81743eef53"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fac416e988563e44bf15fc6a81743eef53">ipc::session::error::Code::S_INVALID_ARGUMENT</a></div><div class="ttdeci">@ S_INVALID_ARGUMENT</div><div class="ttdoc">User called an API with 1 or more arguments against the API spec.</div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a0708d4bec9ae853f4d7e3d7822fc8f2fac734bd48bbfe30867f627363a8d5afc4"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fac734bd48bbfe30867f627363a8d5afc4">ipc::session::error::Code::S_SERVER_MASTER_LOG_IN_REQUEST_CONFIG_MISMATCH</a></div><div class="ttdeci">@ S_SERVER_MASTER_LOG_IN_REQUEST_CONFIG_MISMATCH</div><div class="ttdoc">Session master channel: log-in as server: opposing client's compile-time type config differs from loc...</div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a0708d4bec9ae853f4d7e3d7822fc8f2fafe29343445a7bf167cc186a44bd2c6ed"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fafe29343445a7bf167cc186a44bd2c6ed">ipc::session::error::Code::S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER</a></div><div class="ttdeci">@ S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER</div><div class="ttdoc">Async completion handler is being called prematurely, because underlying object is shutting down,...</div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a6041e74db4e17a75d8eed2541dc026f6"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a6041e74db4e17a75d8eed2541dc026f6">ipc::session::error::operator&gt;&gt;</a></div><div class="ttdeci">std::istream &amp; operator&gt;&gt;(std::istream &amp;is, Code &amp;val)</div><div class="ttdoc">Analogous to transport::error::operator&gt;&gt;().</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2error_8cpp_source.html#l00201">error.cpp:201</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a9056f277d3ebf2778d06a2bb1f337c28"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a9056f277d3ebf2778d06a2bb1f337c28">ipc::session::error::make_error_code</a></div><div class="ttdeci">Error_code make_error_code(Code err_code)</div><div class="ttdoc">Analogous to transport::error::make_error_code().</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2error_8cpp_source.html#l00079">error.cpp:79</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_ad52f227f6cd73969ba6a898028264413"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#ad52f227f6cd73969ba6a898028264413">ipc::session::error::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, Code val)</div><div class="ttdoc">Analogous to transport::error::operator&lt;&lt;().</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2error_8cpp_source.html#l00195">error.cpp:195</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_aded1c40e8ae8a6ba0b9af47ab48a13bb"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#aded1c40e8ae8a6ba0b9af47ab48a13bb">ipc::session::error::S_CODE_LOWEST_INT_VALUE</a></div><div class="ttdeci">constexpr int S_CODE_LOWEST_INT_VALUE</div><div class="ttdoc">Numeric value of the lowest Code.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2error_8hpp_source.html#l00037">error.hpp:37</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ae6ac47812a90d1287c61e0b7de7bc4f5"><div class="ttname"><a href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">ipc::util::String_view</a></div><div class="ttdeci">flow::util::String_view String_view</div><div class="ttdoc">Short-hand for Flow's String_view.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00115">util_fwd.hpp:115</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="autil__fwd_8hpp_html"><div class="ttname"><a href="util__fwd_8hpp.html">util_fwd.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:26 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
